Category

Interfaces

CategoryProps

Properties

CategoryFeedProps?

optional CategoryFeedProps: CategoryFeedProps

Props to spread to Categoryfeed component

Default

{}

Source

Category/Category.tsx:70

FeedObjectProps?

optional FeedObjectProps: FeedObjectProps

Props to spread to single feed object

Default

empty object

Source

Category/Category.tsx:58

FeedSidebarProps?

optional FeedSidebarProps: StickyBoxProps

Props to spread to single feed object

Default

{top: 0, bottomBoundary: `#${id}`}

Source

Category/Category.tsx:64

category?

optional category: SCCategoryType

Category Object

Default

null

Source

Category/Category.tsx:40

categoryId?

optional categoryId: string | number

Id of the category for filter the feed

Default

null

Source

Category/Category.tsx:46

className?

optional className: string

Overrides or extends the styles applied to the component.

Default

null

Source

Category/Category.tsx:34

id?

optional id: string

Id of the feed object

Default

'feed'

Source

Category/Category.tsx:28

widgets?

optional widgets: SCFeedWidgetType[]

Widgets to be rendered into the feed

Default

[CategoriesFollowed, UserFollowed]

Source

Category/Category.tsx:52

Functions

Category()

Category(inProps): JSX.Element

API documentation for the Community-JS Category Template. Learn about the available props and the CSS API.

This component renders a specific category's template. Take a look at our demo component here

Import

import {Category} from '@selfcommunity/react-templates';

Component Name

The name SCCategoryTemplate can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCCategoryTemplate-root	Styles applied to the root element.
feed	.SCCategoryTemplate-feed	Styles applied to the feed element.

Parameters

Parameter	Type	Description
inProps	CategoryProps

Returns

JSX.Element

Source

Category/Category.tsx:98

---

CategorySkeleton()

CategorySkeleton(): JSX.Element

API documentation for the Community-JS Category Skeleton Template. Learn about the available props and the CSS API.

Import

import {CategorySkeleton} from '@selfcommunity/react-templates';

Component Name

The name SCCategoryTemplate-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCCategoryTemplate-skeleton-root	Styles applied to the root element.

Returns

JSX.Element

Source

Category/Skeleton.tsx:37